home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / o_ren171.zip / O_RENUM.DOC < prev    next >
Text File  |  1991-08-05  |  5KB  |  108 lines
  1.                                 O_RENUM
  2.  
  3.              A message area renumber/killer for OPUS 1.1x
  4.              A message area renumber/killer for OPUS 1.7x
  5.  
  6. O_RENUM is an outgrowth of the work of Bob Hartman, Doug Boone and Bob
  7. Davis.  Without their trailblazing, O_RENUM would never have come to be.
  8.  
  9. O_RENUM is a command line driven program.  It has no configuration file.
  10. It can create, maintain and use a parameter data file (RENUM.DAT) to
  11. make repeated renumber operations of the same area easier from day to day.
  12.  
  13. The usual cryptic definition of usage:
  14. O_RENUM [-K] [-N=#1,#2] [-D ##] [-S] [-M=#] [-F] [-E=path] [-O=path]
  15.      [-T=#] [-R] [#|path|conf]
  16.  
  17. (as usual, all of the above must be on one line for the command).
  18.  
  19. Equal signs are optional: they may be removed or replace by spaces.  The
  20. comma (for the -N command) may be replaced by an equal sign or a space.
  21.  
  22. The parameters and their functions:
  23.  
  24. -2 .............. Opus version 1.7x or above.
  25. -K .............. Kill received messages
  26. -S .............. Delete messages that have already been sent
  27. -N=#1,#2 ........ Keep the first #1 messages and the last #2 messages
  28. -D=## ........... Kill message more than ## days old
  29. -M=# ............ Maximum number of messages to handle (100-4500)
  30. -F .............. Fast renum (don't relink message chains)
  31. -E=path ......... Path (disk:\dir) to ECHO.CTL
  32. -O path ......... Path (disk:\dir) to OPUS SYSTEM??.DAT files
  33. -T # ............ Threshhold (kill only if more than # msgs to kill)
  34. -R .............. Renumber the messages
  35. -W .............. Write parameters to RENUM.DAT and terminate
  36. -A .............. Automatic renum (use data in RENUM.DAT)
  37. #/path/conf ..... Area number, path or conference name (tag) for messages
  38.  
  39. -W and -A require an area number, either from the command line or from
  40. ECHO.CTL; both require an OPUS SYSTEM PATH (-o).  If -W is specified,
  41. the parameters are written to the RENUM.DAT file and O_RENUM terminates,
  42. meaning that no renumbering takes place.  Only the flags and number
  43. data are written to RENUM.DAT: the paths are not and must always be
  44. specified on the command line.
  45.  
  46. Argument groups may be in any order.  Use a space to separate argument groups.
  47. Parameters within a group may be run together with the command or separated
  48. by a space or an equal sign.  (Exception: the numbers with the -N argument
  49. group must be separated by a space, an equal sign or a comma.)  Notation may
  50. be mixed with the command line.  <Complain now, Patrick!  I dare you!>
  51.  
  52. Examples:
  53.  
  54. O_RENUM MEADOW -A -e=c:\opus -o=c:\opus\system
  55.         renumber the area names "MEADOW" using the parameters from RENUM.DAT.
  56.         ECHO.CTL is in directory c:\opus
  57.         OPUS' system##.dat files are in directory c:\opus\system
  58.         If MEADOW is found in ECHO.CTL, O_RENUM will also update the
  59.            USER.DAT file for the last message read.
  60.  
  61. o_renum c:\msg\net -k -s -r -e=c:\opus -o=c:\opus\system -t=10 -d=5
  62.         renumber the directory c:\msg\net
  63.         ECHO.CTL is in directory c:\opus
  64.         OPUS' system##.dat files are in directory C:\OPUS\SYSTEM
  65.         kill all messages that have been received (-k)
  66.         kill all messages that have been sent (-s)
  67.         renumber the messages (-r)
  68.         kill all messages 5 days old or older
  69.         only do the above if 10 or more messages are found to be deleted
  70.  
  71. O_RENUM FOR_SALE -t 50 -d 2 -ec:\opus -oc:\opus\system -w
  72.         Write "-t 50 -d 2" (in binary format) to RENUM.DAT (which will
  73.         be stored in C:\OPUS\SYSTEM) for area FOR_SALE if FOR_SALE
  74.         is found in ECHO.CTL.  Do nothing else.
  75.  
  76. O_RENUM FOR_SALE -t=50 -d 2 -e c:\opus -o=c:\opus\sytem -w -a
  77.         If FOR_SALE is found in ECHO.CTL, read the renum parameters for
  78.         the are from RENUM.DAT; update the -t and -d parameters as specified;
  79.         write the new parameters back to the file.  Do nothing else.
  80.  
  81.  
  82. O_RENUM will set the errorlevel to something other than 0 if it detects
  83. an error.  The following table describes the errorlevels:
  84.  
  85. EL  DESCRIPTION
  86.  0  Successful or no renumber based on threshhold
  87.  1  Neither area number nor name given
  88.  2  Insufficient memory for message data
  89.  3  Error getting system info from SYSTEM.DAT
  90.  4  Write of RENUM parameters requested - no other processing performed
  91.  5  Can't find message path
  92.  6  Insufficient memory for user file data
  93.  7  Message number exceeds requeste max
  94.  8  Help (no arguments given)
  95.  
  96. With version 1.10F of O_RENUM, a more intelligent command line parser has
  97. been implemented.  Specificially, command parameters may be separated with
  98. spaces (as has been required in the past) or run together with an optional
  99. equal sign.  Also, for the N parameter, the two numbers may be separated
  100. by a space, a comma or an equal sign.  Thus:
  101.  
  102.         -N=1,10  *or* -N1,10 *or* -N 1 10 *or* -N 1,10 *or* -N1 10
  103.         -Oc:\opus *or* -O=c:\opus *or* -O c:\opus
  104.  
  105. and so on for ALL options.  This effectively makes the typo in previous
  106. version of the documentation one of the acceptable formats <grin>.
  107.  
  108.